<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ReadablePeriod xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/goda/time/ReadablePeriod.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment">/**</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * Defines a time period specified in terms of individual duration fields</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * such as years and days.</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * The implementation of this interface may be mutable or immutable. This</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * interface only gives access to retrieve data, never to change it.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * Periods are split up into multiple fields, for example days and seconds.</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * Implementations are not required to evenly distribute the values across the fields.</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * The value for each field may be positive or negative.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * When a time period is added to an instant, the effect is to add each field in turn.</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * For example, a time period could be defined as 3 months, 2 days and -1 hours.</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * In most circumstances this would be the same as 3 months, 1 day, and 23 hours.</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * However, when adding across a daylight savings boundary, a day may be 23 or 25 hours long.</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * Thus, the time period is always added field by field to the datetime.</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * Periods are independent of chronology, and can only be treated as durations</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * when paired with a time via an interval.</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> *</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * @see ReadableDuration</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * @see ReadableInterval</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> */</em>
<a name="44" href="#44">44</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> {
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>      <em class="jxr_javadoccomment">/**</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * Gets the period type that defines which fields are included in the period.</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     *</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * @return the period type</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     */</em>
<a name="51" href="#51">51</a>      <a href="../../../org/goda/time/PeriodType.html">PeriodType</a> getPeriodType();
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <em class="jxr_javadoccomment">/**</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * Gets the number of fields that this period supports.</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     *</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @return the number of fields supported</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     */</em>
<a name="58" href="#58">58</a>      <strong class="jxr_keyword">int</strong> size();
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <em class="jxr_javadoccomment">/**</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * Gets the field type at the specified index.</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     *</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * @param index  the index to retrieve</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * @return the field at the specified index</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * @throws IndexOutOfBoundsException if the index is invalid</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     */</em>
<a name="67" href="#67">67</a>      <a href="../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> getFieldType(<strong class="jxr_keyword">int</strong> index);
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em class="jxr_javadoccomment">/**</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * Gets the value at the specified index.</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     *</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * @param index  the index to retrieve</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * @return the value of the field at the specified index</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * @throws IndexOutOfBoundsException if the index is invalid</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     */</em>
<a name="76" href="#76">76</a>      <strong class="jxr_keyword">int</strong> getValue(<strong class="jxr_keyword">int</strong> index);
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <em class="jxr_javadoccomment">/**</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * Gets the value of one of the fields.</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * If the field type specified is not supported by the period then zero</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * is returned.</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     *</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @param field  the field type to query, null returns zero</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * @return the value of that field, zero if field not supported</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     */</em>
<a name="87" href="#87">87</a>      <strong class="jxr_keyword">int</strong> get(<a href="../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> field);
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <em class="jxr_javadoccomment">/**</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * Checks whether the field type specified is supported by this period.</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     *</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * @param field  the field to check, may be null which returns false</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @return true if the field is supported</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     */</em>
<a name="95" href="#95">95</a>      <strong class="jxr_keyword">boolean</strong> isSupported(<a href="../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> field);
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="98" href="#98">98</a>      <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * Get this period as an immutable &lt;code&gt;Period&lt;/code&gt; object.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * This will either typecast this instance, or create a new &lt;code&gt;Period&lt;/code&gt;.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * </em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @return a Duration using the same field set and values</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     */</em>
<a name="105" href="#105">105</a>     <a href="../../../org/goda/time/Period.html">Period</a> toPeriod();
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>     <em class="jxr_javadoccomment">/**</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * Get this object as a &lt;code&gt;MutablePeriod&lt;/code&gt;.</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * This will always return a new &lt;code&gt;MutablePeriod&lt;/code&gt; with the same fields.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * </em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @return a MutablePeriod using the same field set and values</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     */</em>
<a name="114" href="#114">114</a>     <a href="../../../org/goda/time/MutablePeriod.html">MutablePeriod</a> toMutablePeriod();
<a name="115" href="#115">115</a> 
<a name="116" href="#116">116</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="117" href="#117">117</a>     <em class="jxr_javadoccomment">/**</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * Compares this object with the specified object for equality based</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * on the value and type of each supported field.</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * All ReadablePeriod instances are accepted.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * Note that a period of 1 day is not equal to a period of 24 hours,</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * nor is 1 hour equal to 60 minutes. Only periods with the same amount</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * in each field are equal.</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * This is because periods represent an abstracted definition of a time</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * period (eg. a day may not actually be 24 hours, it might be 23 or 25</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * at daylight savings boundary).</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * To compare the actual duration of two periods, convert both to</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * {@link Duration}s, an operation that emphasises that the result may</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * differ according to the date you choose.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     *</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @param readablePeriod  a readable period to check against</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * @return true if all the field values and types are equal, false if</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     *  not or the period is null or of an incorrect type</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     */</em>
<a name="138" href="#138">138</a>     <strong class="jxr_keyword">boolean</strong> equals(Object readablePeriod);
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <em class="jxr_javadoccomment">/**</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * Gets a hash code for the period that is compatible with the equals method.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * The hashcode is calculated as follows:</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     *  int total = 17;</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     *  for (int i = 0; i &lt; fields.length; i++) {</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     *      total = 27 * total + getValue(i);</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     *      total = 27 * total + getFieldType(i).hashCode();</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     *  }</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     *  return total;</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     *</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * @return a hash code</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     */</em>
<a name="154" href="#154">154</a>     <strong class="jxr_keyword">int</strong> hashCode();
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="157" href="#157">157</a>     <em class="jxr_javadoccomment">/**</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * Gets the value as a String in the style of the ISO8601 duration format.</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * Technically, the output can breach the ISO specification as weeks may be included.</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * For example, "PT6H3M5S" represents 6 hours, 3 minutes, 5 seconds.</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     *</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @return the value as an ISO8601 style string</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     */</em>
<a name="165" href="#165">165</a>     String toString();
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

